home *** CD-ROM | disk | FTP | other *** search
/ Aminet 15 / Aminet 15 - Nov 1996.iso / Aminet / dev / misc / BST_SystemDocs.lha / BeastV1 / Docs / ROBO_Docs / BST_BaseClass.doc < prev    next >
Encoding:
Text File  |  1996-04-19  |  2.3 KB  |  123 lines
  1. TABLE OF CONTENTS
  2. 0001 BST_BaseClass/BST_BaseInstance
  3. 0002 BST_BaseClass/mth_Dispose_BST_BaseClass
  4. 0003 BST_BaseClass/mth_GetAttr_BST_BaseClass
  5. 0004 BST_BaseClass/mth_Init_BST_BaseClass
  6. 0005 BST_BaseClass/mth_SetAttr_BST_BaseClass
  7. 0006 Beast/BST_BaseClass
  8. BST_BaseClass/BST_BaseInstance
  9.  
  10. NAME
  11.       BST_BaseInstance - (Under construction)
  12.  
  13.  
  14. BST_BaseClass/mth_Dispose_BST_BaseClass
  15.  
  16. NAME
  17.       mth_Dispose - Dispose the object. (V1 Bravo)
  18.  
  19.  
  20. BST_BaseClass/mth_GetAttr_BST_BaseClass
  21.  
  22. NAME
  23.       mth_GetAttr - Get attributes. (V1 Bravo)
  24.  
  25.  
  26. FUNCTION
  27.       Get the baseclass attributes. OBM_GETATTR
  28.  
  29.  
  30. INPUTS
  31.       TagList -
  32.         BTA_NumberOf    - af[E]
  33.         BTA_Title    - af[IFT( BTA_type_CString )]
  34.             Pointer to the title of the object, _do not_
  35.             change the string of this pointer. Read only.
  36.         BTA_ClassName    - af[IFT( BTA_type_CString )]
  37.             Pointer to the title of the object class. Read only.
  38.  
  39.  
  40. BST_BaseClass/mth_Init_BST_BaseClass
  41.  
  42. NAME
  43.       mth_Init - Init object. (V1 Bravo)
  44.  
  45.  
  46. FUNCTION
  47.       Init the object.
  48.       Function equal to the OBM_SETATTR method.
  49.  
  50.  
  51. SEE ALSO
  52.       mth_SetAttr_BST_BaseClass
  53.  
  54.  
  55. BST_BaseClass/mth_SetAttr_BST_BaseClass
  56.  
  57. NAME
  58.       mth_SetAttr - Set attributes. (V1 Bravo)
  59.  
  60.  
  61. FUNCTION
  62.       Set the baseclass attributes. See OBM_SETATTR.
  63.  
  64.  
  65. INPUTS
  66.       TagList -
  67.         BTA_NumberOf    - af[E]
  68.         BTA_Title    - af[IT( BTA_type_CString )]
  69.             The title of the object to be set
  70.             (15 character maximum (V1 Bravo)) to be changed
  71.             in the future.
  72.  
  73.  
  74. Beast/BST_BaseClass
  75.  
  76. NAME
  77.       BST_BaseClass -- (V1 Bravo)
  78.  
  79.  
  80. COPYRIGHT
  81.       Maverick Software Development
  82.  
  83.     SUPERCLASS
  84.       None
  85.  
  86.  
  87. FUNCTION
  88.       Serve as base class for a lot of BEAST classes.
  89.  
  90.         The method names are defined as follows;
  91.         mth_[method name]_[class name]
  92.  
  93.         The following tokens are used to explain the methods.
  94.  
  95.         af[..] = Attribute flags;
  96.             R    = Required, must be supplied.
  97.             P    = When not available, the method will try retrieve it from it's parents.
  98.             S    = This tag is used/filled in by a superclass of this class.
  99.             E    = When supplied the object will act more efficient.
  100.             D(n) = Default value when it's not supplied and it cannot be retrieved
  101.                    from something else.
  102.             A    = Always supplied by the method.
  103.             F    = This tag is filled in by the method.
  104.             I    = BTF_Ignore flag is set when processed.
  105.             T(n) = Extra information about the typeof the tag.
  106.  
  107.  
  108. AUTHOR
  109.       Jacco van Weert
  110.  
  111.  
  112. CREATION DATE
  113.       4-Apr-96
  114.  
  115.  
  116. MODIFICATION HISTORY
  117.  
  118.  
  119. NOTES
  120.  
  121.  
  122.  
  123.